<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos  -->
			<title>Docs For Class i18n</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
						<script src="../media/lib/classTree.js"></script>
												<script language="javascript" type="text/javascript">
				var imgPlus = new Image();
				var imgMinus = new Image();
				imgPlus.src = "../media/images/plus.png";
				imgMinus.src = "../media/images/minus.png";
				
				function showNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgMinus.src;
					oTable.style.display = "block";
				}
				
				function hideNode(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
							var oImg = document.layers["img" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
							var oImg = document.all["img" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
							var oImg = document.getElementById("img" + Node);
									break;
							}
					oImg.src = imgPlus.src;
					oTable.style.display = "none";
				}
				
				function nodeIsVisible(Node){
							switch(navigator.family){
								case 'nn4':
									// Nav 4.x code fork...
							var oTable = document.layers["span" + Node];
									break;
								case 'ie4':
									// IE 4/5 code fork...
							var oTable = document.all["span" + Node];
									break;
								case 'gecko':
									// Standards Compliant code fork...
							var oTable = document.getElementById("span" + Node);
									break;
							}
					return (oTable && oTable.style.display == "block");
				}
				
				function toggleNodeVisibility(Node){
					if (nodeIsVisible(Node)){
						hideNode(Node);
					}else{
						showNode(Node);
					}
				}
			</script>
					</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> i18n</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Provides static methods to aid in internalisation.</p>
		<p class="notes">
			Located in <a class="field" href="_rho---i18n.class.php.html">/rho/i18n.class.php</a> (line <span class="field">14</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
											
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">string</span>
										<a href="#currency" title="details" class="method-name">currency</a>
											(<span class="var-type">float|int</span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$symbol</span> = <span class="var-default">NULL</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">TRUE</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">void</span>
										<a href="#loadLangFile" title="details" class="method-name">loadLangFile</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">&$lang_file</span>)
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">string</span>
										<a href="#number" title="details" class="method-name">number</a>
											(<span class="var-type">int|float</span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$decimals</span> = <span class="var-default">0</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">TRUE</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">bool</span>
										<a href="#setLang" title="details" class="method-name">setLang</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$base</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$region</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$varient</span> = <span class="var-default">''</span>])
									</div>
															
				<div class="method-definition">
					<img src="../media/images/StaticMethod.png" alt=" "/>
					static 						<span class="method-result">string</span>
										<a href="#tr" title="details" class="method-name">tr</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">array()</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">TRUE</span>])
									</div>
																																																							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodcurrency" id="currency"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static currency</span> (line <span class="line-number">183</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formats an amount to the local currency.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The formatted number.</li>
				<li><span class="field">see:</span> <a href="../Rho/i18n.html#methodnumber">i18n::number()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string</span>
		<span class="method-name">
			currency
		</span>
					(<span class="var-type">float|int</span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$symbol</span> = <span class="var-default">NULL</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">TRUE</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">float|int</span>
				<span class="var-name">$number</span><span class="var-description">: The number to format.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$symbol</span><span class="var-description">: The currency symbol to use. The default of NULL means the local currency symbol will be used.</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$echo</span><span class="var-description">: Whether to echo the result before returning - default TRUE.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodloadLangFile" id="loadLangFile"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static loadLangFile</span> (line <span class="line-number">123</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Attempts to load a language file based on the current lang.</p>
<p class="description"><p>This method is called automatically by tr() as needed, and does not normally need to be called manually.  If the file does not exist, errors will logged.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../Rho/i18n.html#methodtr">i18n::tr()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">void</span>
		<span class="method-name">
			loadLangFile
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">&$lang_file</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">&$lang_file</span><span class="var-description">: Name of the translation file to load.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodnumber" id="number"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static number</span> (line <span class="line-number">170</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formats a number to the current language format.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The formatted number.</li>
				<li><span class="field">see:</span> <a href="../Rho/i18n.html#methodcurrency">i18n::currency()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string</span>
		<span class="method-name">
			number
		</span>
					(<span class="var-type">int|float</span>&nbsp;<span class="var-name">$number</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$decimals</span> = <span class="var-default">0</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">TRUE</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int|float</span>
				<span class="var-name">$number</span><span class="var-description">: The number to format.</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$decimals</span><span class="var-description">: The number of decimal places to show - default is 0 which works well for integers.</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$echo</span><span class="var-description">: Whether to echo the result before returning - default TRUE.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetLang" id="setLang"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static setLang</span> (line <span class="line-number">77</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Change the language used.</p>
<p class="description"><p>If the base language specified does not exist, as specified in conf 'lang_base_avail',  nothing will change.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE on success.</li>
				<li><span class="field">see:</span> <a href="../Rho/i18n.html#methodtr">i18n::tr()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">bool</span>
		<span class="method-name">
			setLang
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$base</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$region</span> = <span class="var-default">''</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$varient</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$base</span><span class="var-description">: 2 letter language code, e.g. 'en'.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$region</span><span class="var-description">: (Optional) 2 letter country code uppercase, e.g. 'US'.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$varient</span><span class="var-description">: Optional - a language varient such as 'informal'.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtr" id="tr"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/StaticMethod.png" />
		<span class="method-title">static tr</span> (line <span class="line-number">34</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Translation function.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The translated string.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string</span>
		<span class="method-name">
			tr
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">array()</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$echo</span> = <span class="var-default">TRUE</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$key</span><span class="var-description">: The string to translate eg. core.error.</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$args</span><span class="var-description">: Optional - List of values to include in the output.</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$echo</span><span class="var-description">: Whether to echo the result before returning - default TRUE.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Tue, 13 Oct 2009 19:17:24 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>